home *** CD-ROM | disk | FTP | other *** search
/ Aminet 7 / Aminet 7 - August 1995.iso / Aminet / gfx / misc / ScreenGrab.lha / ScreenGrab.autodoc < prev   
Text File  |  1995-06-10  |  3KB  |  80 lines
  1. ScreenGrab/Documentation                             ScreenGrab/Documentation
  2.  
  3.    PURPOSE
  4.      To grab the contents of any public screen in the system.
  5.  
  6.    COPYRIGHT
  7.      The copyright in this package is owned by Paul Huxham © 1995.
  8.  
  9.    DISTRIBUTION
  10.      ScreenGrab should be distributed at no charge to the end user (for
  11.      non commerical applications), however should a duplication charge be
  12.      made, it should not exceed the cost of a blank 3.5" disk.
  13.      For commercial applications of ScreenGrab, contact the author for
  14.      further information concerning distribution.
  15.  
  16.    REQUIREMENTS
  17.      ScreenGrab requires a minimum of Kickstart 3.0 to function.
  18.  
  19.    CONTENTS
  20.      This package should contain:
  21.      ScreenGrab = This is the program that does all the work.
  22.      ScreenGrab.autodoc = The document you are reading now.
  23.  
  24.    USAGE
  25.      ScreenGrab can only be called from a shell and supports the following
  26.      arguments:
  27.  
  28.         FILE,PATH/K,PUBS=PUBSCREEN,UNIQUE/S,NOBEEP/S,FRONT=FRONTSCREEN/S
  29.  
  30.      FILE is a path/filename to save the image to.
  31.  
  32.      PATH if specified overrides FILE and generates a unique filename
  33.           automatically for saving. eg RAM:
  34.  
  35.      PUBSCREEN is the name of the public screen to save. It does not have to
  36.                be the frontmost screen.
  37.  
  38.      UNIQUE if specified and FILE exists, alters the filename until a unique
  39.             name is generated.
  40.  
  41.      NOBEEP prevents ScreenGrab from displaybeeping after the screen is
  42.             saved. Normally the screen will displaybeep.
  43.  
  44.      FRONTSCREEN overrides PUBSCREEN and saves the frontmost screen of the
  45.                  display even if it not a public screen.
  46.  
  47.    EXAMPLES
  48.      screengrab pubs=Workbench file=ram:2 unique
  49.      If a file ram:2 exists, a new name ram:2.1 will be created, if it also
  50.      does not exist.
  51.  
  52.      screengrab pubs=Workbench path=ram:
  53.      Generates a name somewhat like ram:Grab.547297680, and will be unique.
  54.  
  55.      screengrab pubs=Workbench file=ram:2
  56.      Will write over the file ram:2.1 if it exists.
  57.  
  58.    NOTES
  59.      I have a toolmanager hotkey LALT RALT G to launch ScreenGrab, that uses
  60.      FRONTPUBSCREEN to grab screens.
  61.  
  62.      The screen being grabbed does not have to be in the front. Because it is
  63.      done by name, it can be anywhere.
  64.  
  65.      ScreenGrab should grab screens from external graphic cards that hook in
  66.      through the display database. eg Picasso and Spectrum (untested however)
  67.  
  68.    KNOWN PROBLEMS
  69.      FRONTSCREEN is not coded yet.
  70.  
  71.    AUTHOR
  72.      You can contact the author via:
  73.        Email: paulh@Perth.DIALix.oz.au
  74.      or
  75.        P.O. Box 875
  76.        Morley,
  77.        Perth,
  78.        Western Australia 6943
  79.  
  80.